home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_hylafax.idb / usr / freeware / catman / u_man / cat1 / textfmt.Z / textfmt
Text File  |  2002-07-08  |  11KB  |  242 lines
  1. TEXTFMT(1)                           TEXTFMT(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        textfmt - convert text to POSTSCRIPT for    facsimile trans
  7.        mission
  8.  
  9. SSYYNNOOPPSSIISS
  10.        $${{LLIIBBEEXXEECC}}//tteexxttffmmtt [ _o_p_t_i_o_n_s ] [    _f_i_l_e_s...  ]
  11.  
  12. DDEESSCCRRIIPPTTIIOONN
  13.        _t_e_x_t_f_m_t    takes  ASCII   text   and   generates    formatted
  14.        POSTSCRIPT  suitable  for  facsimile transmission.  It is
  15.        usually invoked as a filter program by the _s_e_n_d_f_a_x(1) pro
  16.        gram.   Input  files may    be specified on    the command line.
  17.        If none are given, then _t_e_x_t_f_m_t will  read  from     standard
  18.        input.
  19.  
  20.        By  default, _t_e_x_t_f_m_t will generate an output document that
  21.        is formatted with a single vertical column of text, set in
  22.        a 10 point fixed    width font, and    with a simple page header
  23.        that consists of    the file name,    last  modification  date,
  24.        and the page number.  Pages are generated according to the
  25.        default    page  dimensions  (see    _p_a_g_e_s_i_z_e_s(${MANNUM4_5})).
  26.        When  multi-column  output  is  requested,  text    is set by
  27.        default with a 7    point fixed width font.
  28.  
  29. OOPPTTIIOONNSS
  30.        Many of the options to _t_e_x_t_f_m_t have been    chosen    for  com
  31.        patibility with the Adobe Systems' _e_n_s_c_r_i_p_t program; other
  32.        options    are  for  features  that  are  not  provided   by
  33.        _e_n_s_c_r_i_p_t.
  34.  
  35.        --11     Set text in one column.
  36.  
  37.        --22     Set text two columns.
  38.  
  39.        --BB     Suppress page headers.
  40.  
  41.        --cc     Clip  long  text    lines instead of wrapping them at
  42.           page margins.
  43.  
  44.        --DD     Do not use ISO 8859-1  encoding  in  the    generated
  45.           POSTSCRIPT.
  46.  
  47.        --ff _f_o_n_t
  48.           Set text using the POSTSCRIPT font named _f_o_n_t.
  49.  
  50.        --FF _f_o_n_t_d_i_r_(_s_)
  51.           _P_a_t_h_(_s_) to afm font files.
  52.  
  53.        --GG     Use a gaudy-style    page header.
  54.  
  55.        --mm _c_o_l_s
  56.           Set text in _c_o_l_s columns.
  57.  
  58.        --MMll==_#_,rr==_#_,tt==_#_,bb==_#
  59.           Set the page margins; the    default    margins    are: left
  60.           and right    .25 inch, top .85 inch,    bottom .5 inch.
  61.  
  62.        --oo     Draw an outline around each  column  of  text;  the
  63.           specified    number defines the width of the    line that
  64.           is drawn.
  65.  
  66.        --pp _p_t_s Set text using fonts with    _p_t_s point size.
  67.  
  68.        --rr     Set pages    rotated    by  90    degrees     (in  ``Landscape
  69.           mode'').
  70.  
  71.        --RR     Set pages    unrotated (in ``Portrait mode'').
  72.  
  73.        --ss _s_i_z_e
  74.           Set  the    output    size  according    to the named page
  75.           size.  Images are    normally created with  a  system-
  76.           default  page size (usually letter-size pages, 8.5"
  77.           by 11", for sites     in  North  America).    Alternate
  78.           page  sizes are specified    symbolically using either
  79.           the name or abbreviation of an entry in  the  _p_a_g_e_
  80.           _s_i_z_e_s(${MANNUM4_5}) database; e.g.  _a_3 (ISO A3), _a_4
  81.           (ISO A4),    _a_5 (ISO    A5), _a_6    (ISO A6),  _b_4  (ISO  B4),
  82.           _n_a_-_l_e_t  (North  American    Letter), _u_s_-_l_e_g    (American
  83.           Legal), _u_s_-_l_e_d (American Ledger),    _u_s_-_e_x_e    (American
  84.           Executive),  _j_p_-_l_e_t  (Japanese  Letter), and _j_p_-_l_e_g
  85.           (Japanese    Legal).     Comparisons are case-insensitive
  86.           and  any match of    a substring of the full    page-size
  87.           name is  sufficient;  e.g.  ``legal''  would  match
  88.           ``American Legal''.
  89.  
  90.        --UU     Reverse  collate    pages; that is the last    page will
  91.           appear first in the resultant POSTSCRIPT,    then  the
  92.           next-to-last page, etc.
  93.  
  94.        --VV _s_p_a_c_i_n_g
  95.           Set  the    line  height; the default height is 1.2    x
  96.           point size.
  97.  
  98. CCOONNFFIIGGUURRAATTIIOONN PPAARRAAMMEETTEERRSS
  99.        _t_e_x_t_f_m_t reads configuration  information     from  the  files
  100.        $${{LLIIBBDDAATTAA}}//hhyyllaa..ccoonnff,  and ~~//..hhyyllaarrcc; in    that order.  Con
  101.        figuration  files  follow  the  conventions  described  in
  102.        _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1).  The following configuration parameters
  103.        are recognized:
  104.        TTaagg  TTyyppee DDeeffaauulltt   DDeessccrriippttiioonn
  105.        Columns     integer   1    number of columns in formatted output
  106.        GaudyHeaders   boolean    No   enable/disable guady page headers
  107.        FontMap         string  _s_e_e _b_e_l_o_w location    of ghostscript Fontmap file
  108.        FontPath         string  _s_e_e _b_e_l_o_w directory for font metric files
  109.        ISO8859     boolean   Yes    use ISO    8859-1 character encoding
  110.        LineWrap     boolean   Yes    wrap/truncate text lines
  111.        Orientation    string    portrait  orientation of text on page
  112.        OutlineMargin  inches    0    width of outline line
  113.        PageCollation  string    forward      collate pages    in forward or reverse direction
  114.        PageHeaders    boolean    Yes  enable/disable page headers
  115.        PageHeight     float    -    output page height
  116.        PageMargins    string    _s_e_e _b_e_l_o_w margins for formatted    page
  117.        PageSize     string       default   output page size from database
  118.        PageWidth float       -    output page width
  119.        TabStop     integer   8    inter-stop setting in characters
  120.        TextFont     string       Courier   name of font for setting text
  121.        TextLineHeight inches    -    text formatting line height control
  122.        TextPointSize  inches    _s_e_e _b_e_l_o_w size to use in setting text
  123.  
  124.        The configuration parameters are     explained  below.   Most
  125.        parameters correspond to    a command line option.    Parameter
  126.        values identified above as _i_n_c_h_e_s are converted    according
  127.        to  the following conventions (where ``#.##'' is    a decimal
  128.        number):
  129.           #.##bp    big point (1in = 72bp)
  130.           #.##cc    cicero (1cc = 12dd)
  131.           #.##cm    centimeter
  132.           #.##dd    didot point (1157dd = 1238pt)
  133.           #.##in    inch
  134.           #.##mm    millimeter (10mm = 1cm)
  135.           #.##pc    pica (1pc = 12pt)
  136.           #.##pt    point (72.27pt = 1in)
  137.           #.##sp    scaled point (65536sp =    1pt)
  138.  
  139.        Unit names can be upper or lower    case but no  white  space
  140.        is  permitted  between  the  number  and    the unit.  Values
  141.        specified with no unit are interpreted as points.
  142.  
  143.        CCoolluummnnss          The number  of  columns  to  set    text  in.
  144.               (Equivalent to the --mm option.)
  145.  
  146.        FFoonnttMMaapp          The  directory  or  directories  where  the
  147.               ghostscript Fontmap  file(s)  are     located;
  148.               multiple    paths  are  seperated  by a colon
  149.               (":"). The Fontmap table allows the  trans
  150.               lation  of the descriptive name of the font
  151.               (as used by the _T_e_x_t_F_o_n_t parameter) to  the
  152.               ghostscript  font     filenames.  Setting  the
  153.               value to "" (zero    length    string)     disables
  154.               this translation and provides functionality
  155.               with RIPs    other than ghostscript.
  156.  
  157.        FFoonnttPPaatthh          The path    where  Adobe  Font  Metric  (AFM)
  158.               files  are located; by default ${FONTPATH}.
  159.               (Equivalent to the --FF option.)
  160.  
  161.        GGaauuddyyHHeeaaddeerrss   Control whether or not to    use a gaudy-style
  162.               page   header.    (Equivalent   to  the  --GG
  163.               option.)
  164.  
  165.        IISSOO88885599          Control the use of ISO 8859-1  encoding  in
  166.               the generated POSTSCRIPT (Equivalent to the
  167.               --DD option.)
  168.  
  169.        LLiinneeWWrraapp          Control whether long text    lines are wrapper
  170.               or  truncated  at     the  right  hand margin.
  171.               (Equivalent to the --cc option.)
  172.  
  173.        OOrriieennttaattiioonn    Control whether pages are    oriented horizon
  174.               tally (``landscape'') or vertically (``por
  175.               trait'').     (Equivalent to     the  --rr  and  --RR
  176.               options.)
  177.  
  178.        OOuuttlliinneeMMaarrggiinn  Control whether columns of text have a line
  179.               drawn around them     and  the  width  of  the
  180.               line.  Setting this parameter to 0 disables
  181.               outlines.     (Equivalent to    the --oo option.)
  182.  
  183.        PPaaggeeCCoollllaattiioonn  Control whether the output file  has  pages
  184.               collated    in  the     same  order as    the input
  185.               file  (``forward'')  or  in  reverse  order
  186.               (``reverse).    (Equivalent   to     the   --UU
  187.               option.)
  188.  
  189.        PPaaggeeHHeeaaddeerrss    Control whether page headers are generated.
  190.               (Equivalent to the --BB option.)
  191.  
  192.        PPaaggeeHHeeiigghhtt     Set  the    output    page height in inches (in
  193.               inches).
  194.  
  195.        PPaaggeeMMaarrggiinnss    Set the output page dimensions.  Dimensions
  196.               are   specified  as  string  of  the  form:
  197.               ``ll==#,rr==#,tt==#,bb==#'' where    ll  indicates  the
  198.               left  margin, rr indicates    the right margin,
  199.               tt    indicates the top margin, bb indicates the
  200.               bottom  margin, and numbers are interpreted
  201.               as _i_n_c_h_e_s.  (Equvalent to    the --MM option.)
  202.  
  203.        PPaaggeeSSiizzee          Set the output  page  dimensions    by  name.
  204.               (Equivalent to the --ss option.)
  205.  
  206.        PPaaggeeWWiiddtthh      Set  the    output    page  width in inches (in
  207.               inches).
  208.  
  209.        TTaabbSSttoopp          Set the tab stop distance; in characters.
  210.  
  211.        TTeexxttFFoonntt          Set the descriptive name of font to use for
  212.               setting    text.     (Equivalent  to  the  --ff
  213.               option.)
  214.  
  215.        TTeexxttLLiinneeHHeeiigghhtt Set the vertical text line height    and spac
  216.               ing.  (Equvalent to the --VV option.)
  217.  
  218.        TTeexxttPPooiinnttSSiizzee  Set  the point size to use in setting text.
  219.               (Equvalent to the    --pp option.)
  220.  
  221. NNOOTTEESS
  222.        If _t_e_x_t_f_m_t is unable to locate font metric information for
  223.        a  font,    then it    will use a fixed-width metric that is 60%
  224.        of the text point size; this metric will    almost    certainly
  225.        result in incorrectly formatted POSTSCRIPT.
  226.  
  227.        _t_e_x_t_f_m_t is distantly related to the _l_p_t_o_p_s program written
  228.        by Don Beebe.
  229.  
  230. FFIILLEESS
  231.        ${LIBDATA}/hyla.conf    system-wide configuration file
  232.        ~/.hylarc           per-user    configuration file
  233.        ${LIBDATA}/pagesizes    page size database
  234.        ${FONTPATH}   font metric files
  235.  
  236. SSEEEE AALLSSOO
  237.        _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1), _s_e_n_d_f_a_x(1), _p_a_g_e_s_i_z_e_s(${MANNUM4_5})
  238.  
  239.  
  240.  
  241.                May 17, 1996               TEXTFMT(1)
  242.